---
layout: m1x_rest
title: Order Addresses
---


<ul class="introduction-menu">
    <li><a href='#RESTAPI-Resource-OrderAddresses-RESTAPI-OrderAddresses'>REST API: Order Addresses</a>
    <ul>
        <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses'>URI: /orders/:orderid/addresses</a>
        <ul>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-GET'>HTTP Method: GET</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-POST'>HTTP Method: POST</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-PUT'>HTTP Method: PUT</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-DELETE'>HTTP Method: DELETE</a></li>
        </ul>
        </li>
        <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing'>URI: /orders/:orderid/addresses/billing</a>
        <ul>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-GET'>HTTP Method: GET</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-POST'>HTTP Method: POST</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-PUT'>HTTP Method: PUT</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-DELETE'>HTTP Method: DELETE</a></li>
        </ul>
        </li>
        <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping'>URI: /orders/:orderid/addresses/shipping</a>
        <ul>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-GET'>HTTP Method: GET</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-POST'>HTTP Method: POST</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-PUT'>HTTP Method: PUT</a></li>
            <li><a href='#RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-DELETE'>HTTP Method: DELETE</a></li>
        </ul>
        </li>
    </ul>
    </li>
    <li><a href='#RESTAPI-Resource-OrderAddresses-OrderAddressesAttributes'>Order Addresses Attributes</a></li>
</ul>


<h3><a name="RESTAPI-Resource-OrderAddresses-RESTAPI-OrderAddresses"></a>REST API: Order Addresses</h3>

<h4><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses"></a>URI: /orders/:orderid/addresses</h4>

<p>Allows you to retrieve information about billing and shipping addresses of the required order.</p>

<p><b>URL Structure</b>: http://magentohost/api/rest/orders/:orderid/addresses<br/>
<b>Version</b>: 1</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-GET"></a>HTTP Method: GET</h5>

<p><b>Description</b>: Allows you to retrieve information on billing and shipping addresses from the required order.<br/>
<b>Notes</b>: Customers can retrieve addresses only from their orders.</p>

<p><b>Authentication</b>: Admin, Customer<br/>
<b>Default Format</b>: XML<br/>
<b>Parameters</b>:<br/>
<em>No Parameters</em></p>

<p><b>Example:</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders/32/addresses</td></tr></table></div>

<p><b>Response Body:</b></p>
<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;data_item&gt;
    &lt;region&gt;Palau&lt;/region&gt;
    &lt;postcode&gt;19103&lt;/postcode&gt;
    &lt;lastname&gt;Doe&lt;/lastname&gt;
    &lt;street&gt;2356 Jody Road Philadelphia
844 Jefferson Street; 4510 Willis Avenue&lt;/street&gt;
    &lt;city&gt;PA&lt;/city&gt;
    &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
    &lt;country_id&gt;US&lt;/country_id&gt;
    &lt;firstname&gt;John&lt;/firstname&gt;
    &lt;address_type&gt;billing&lt;/address_type&gt;
    &lt;prefix&gt;Dr.&lt;/prefix&gt;
    &lt;middlename&gt;&lt;/middlename&gt;
    &lt;suffix&gt;Jr.&lt;/suffix&gt;
    &lt;company&gt;&lt;/company&gt;
  &lt;/data_item&gt;
  &lt;data_item&gt;
    &lt;region&gt;Massachusetts&lt;/region&gt;
    &lt;postcode&gt;01852&lt;/postcode&gt;
    &lt;lastname&gt;Doe&lt;/lastname&gt;
    &lt;street&gt;1073 Smith Street&lt;/street&gt;
    &lt;city&gt;Lowell&lt;/city&gt;
    &lt;telephone&gt;508-857-6870&lt;/telephone&gt;
    &lt;country_id&gt;US&lt;/country_id&gt;
    &lt;firstname&gt;John&lt;/firstname&gt;
    &lt;address_type&gt;shipping&lt;/address_type&gt;
    &lt;prefix&gt;&lt;/prefix&gt;
    &lt;middlename&gt;&lt;/middlename&gt;
    &lt;suffix&gt;&lt;/suffix&gt;
    &lt;company&gt;&lt;/company&gt;
  &lt;/data_item&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-POST"></a>HTTP Method: POST</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-PUT"></a>HTTP Method: PUT</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-DELETE"></a>HTTP Method: DELETE</h5>

<p><b>Description</b>: Not allowed.</p>

<h4><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing"></a>URI: /orders/:orderid/addresses/billing</h4>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-GET"></a>HTTP Method: GET</h5>

<p><b>Description</b>: Allows you to retrieve information on the order billing address.<br/>
<b>Notes</b>: Customers can retrieve information on billing addresses only from their own orders.</p>

<p><b>Authentication</b>: Admin, Customer<br/>
<b>Default Format</b>: XML<br/>
<b>Parameters</b>:<br/>
<em>No Parameters</em></p>

<p><b>Example:</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders/32/addresses/billing</td></tr></table></div>

<p><b>Response example:</b></p>
<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;region&gt;Palau&lt;/region&gt;
  &lt;postcode&gt;19103&lt;/postcode&gt;
  &lt;lastname&gt;Doe&lt;/lastname&gt;
  &lt;street&gt;2356 Jody Road Philadelphia
844 Jefferson Street; 4510 Willis Avenue&lt;/street&gt;
  &lt;city&gt;PA&lt;/city&gt;
  &lt;telephone&gt;610-634-1181&lt;/telephone&gt;
  &lt;country_id&gt;US&lt;/country_id&gt;
  &lt;firstname&gt;John&lt;/firstname&gt;
  &lt;address_type&gt;billing&lt;/address_type&gt;
  &lt;prefix&gt;Dr.&lt;/prefix&gt;
  &lt;middlename&gt;&lt;/middlename&gt;
  &lt;suffix&gt;Jr.&lt;/suffix&gt;
  &lt;company&gt;&lt;/company&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-POST"></a>HTTP Method: POST</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-PUT"></a>HTTP Method: PUT</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-billing-DELETE"></a>HTTP Method: DELETE</h5>

<p><b>Description</b>: Not allowed.</p>


<h4><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping"></a>URI: /orders/:orderid/addresses/shipping</h4>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-GET"></a>HTTP Method: GET</h5>

<p><b>Description</b>: Allows you to retrieve information on the order shipping address.<br/>
<b>Notes</b>: Customers can retrieve information on shipping addresses only from their own orders.</p>

<p><b>Authentication</b>: Admin, Customer<br/>
<b>Default Format</b>: XML<br/>
<b>Parameters</b>:<br/>
<em>No Parameters</em></p>

<p><b>Example:</b></p>

<div class='panelMacro'><table class='infoMacro'><tr><td>GET http://magentohost/api/rest/orders/32/addresses/shipping</td></tr></table></div>

<p><b>Response example:</b></p>
<div class="panel" style="border-width: 1px;"><div class="panelContent">
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div>
		<pre class="theme: Default; brush: java; gutter: false">&lt;?xml version="1.0"?&gt;
&lt;magento_api&gt;
  &lt;region&gt;Massachusetts&lt;/region&gt;
  &lt;postcode&gt;01852&lt;/postcode&gt;
  &lt;lastname&gt;Doe&lt;/lastname&gt;
  &lt;street&gt;1073 Smith Street&lt;/street&gt;
  &lt;city&gt;Lowell&lt;/city&gt;
  &lt;telephone&gt;508-857-6870&lt;/telephone&gt;
  &lt;country_id&gt;US&lt;/country_id&gt;
  &lt;firstname&gt;John&lt;/firstname&gt;
  &lt;address_type&gt;shipping&lt;/address_type&gt;
  &lt;prefix&gt;&lt;/prefix&gt;
  &lt;middlename&gt;&lt;/middlename&gt;
  &lt;suffix&gt;&lt;/suffix&gt;
  &lt;company&gt;&lt;/company&gt;
&lt;/magento_api&gt;</pre>
		</div>
</div></div>
</div></div>


<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-POST"></a>HTTP Method: POST</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-PUT"></a>HTTP Method: PUT</h5>

<p><b>Description</b>: Not allowed.</p>

<h5><a name="RESTAPI-Resource-OrderAddresses-URI--orders--orderid-addresses-shipping-DELETE"></a>HTTP Method: DELETE</h5>

<p><b>Description</b>: Not allowed.</p>

<h3><a name="RESTAPI-Resource-OrderAddresses-OrderAddressesAttributes"></a>Order Addresses Attributes</h3>


<table><tbody>
<tr>
<th> Attribute Name </th>
<th> Attribute Description </th>
</tr>
<tr>
<td> Customer Last Name </td>
<td> Customer last name </td>
</tr>
<tr>
<td> Customer First Name <br class="atl-forced-newline" /> </td>
<td> Customer first name </td>
</tr>
<tr>
<td> Customer Middle Name <br class="atl-forced-newline" /> </td>
<td> Customer middle name or initial </td>
</tr>
<tr>
<td> Customer Prefix <br class="atl-forced-newline" /> </td>
<td> Customer prefix </td>
</tr>
<tr>
<td> Customer Suffix <br class="atl-forced-newline" /> </td>
<td> Customer suffix </td>
</tr>
<tr>
<td> Company <br class="atl-forced-newline" /> </td>
<td> Company name </td>
</tr>
<tr>
<td> Street <br class="atl-forced-newline" /> </td>
<td> Street address </td>
</tr>
<tr>
<td> City <br class="atl-forced-newline" /> </td>
<td> City </td>
</tr>
<tr>
<td> State <br class="atl-forced-newline" /> </td>
<td> State </td>
</tr>
<tr>
<td> ZIP/Postal Code <br class="atl-forced-newline" /> </td>
<td> ZIP or postal code </td>
</tr>
<tr>
<td> Country <br class="atl-forced-newline" /> </td>
<td> Country name </td>
</tr>
<tr>
<td> Phone Number <br class="atl-forced-newline" /> </td>
<td> Customer phone number </td>
</tr>
<tr>
<td> Address Type <br class="atl-forced-newline" /> </td>
<td> Address type. Can have the following values: billing or shipping </td>
</tr>
</tbody></table>


				    
Create the Magento file system owner                   			    
